11.6 Customizing terms and conditions
You can override the standard terms and conditions with a custom set.
Note: The terms and conditions text that is used depends on the workflow and the MyID client you are using:
Workflow |
Client |
Terms and conditions method |
---|---|---|
Activate Card |
MyID Desktop |
HTML template |
Activate Card |
SSA or SSK |
Web service |
Assisted Activation |
MyID Desktop |
HTML template |
Collect My Card, Reprovision Card, Reprovision My Card, Update Card |
MyID Desktop (PIV only) |
SignedTCs.txt |
Collect My Card, Reprovision Card, Reprovision My Card, Update Card |
MyID Desktop (Non-PIV) |
Translation method |
Collect My Card, Update Card |
Self-Service App |
Web service |
11.6.1 Customizing terms and conditions using the HTML template method
For the text that appears in the Activate Card and Assisted Activation workflows in MyID Desktop (on both PIV and non-PIV systems) you must set up an HTML template in the MyID database.
For information on adding HTML templates, contact customer support quoting reference SUP-255 to obtain a copy of the Terms and Conditions document.
Once you have set up a template in the MyID database, within the Credential Profiles workflow, you must select an option from the Terms and Conditions Template drop-down list to select which template to use when activating a card.
11.6.2 Customizing terms and conditions for the web service
The TermsConditions.txt file is located in the following folder by default:
C:\Program Files\Intercede\MyID\SSP\MyIDProcessDriver\Content\
These terms and conditions are displayed to a cardholder, who must agree to the conditions before being allowed to collect their device.
You can use a text editor to change the wording of this agreement.
After you have edited and saved the text file, recycle the MyIDWebService application pool in IIS to ensure that the web service is using the latest version of the file.
11.6.3 Customizing terms and conditions using the SignedTCs.txt method
For the text that appears in the Collect My Card workflow in PIV systems, you must edit a text file called SignedTCs.txt in the res\custom\js\ folder for each language folder on the MyID web server. If the file does not exist, you can create it.
For example:
C:\Program Files\Intercede\MyID\Web\
and:
C:\Program Files\Intercede\MyID\Web\
This allows you to use different terms and conditions for different languages.
In the SignedTCs.txt text file, include the text that you want to display for terms and conditions. You can use HTML formatting and must make sure that the characters you use are safe to display within a web page; for example, you must specify ampersands as & and not as bare & symbols.
For example:
<p><strong>Terms & Conditions</strong></p>
<p>You must agree to the following conditions:</p>
<ol>
<li>The card remains the property of Example Corporation.</li>
<li>Use of this card may be revoked at the sole discretion of Example Corporation for violation of Example Corporation's policies and procedures.</li>
<li>...</li>
</ol>
<p>If you do not accept these terms and conditions, click <strong>Reject</strong>.</p>
11.6.4 Customizing terms and conditions using the translation method
For the text that appears in the Collect My Card workflow in non-PIV systems, customizing the terms and conditions on non-PIV systems requires the use of the MyID Translator tool. Translate the text for the following translation IDs:
- 21487 – Terms and Conditions heading.
- 21488 to 21495 – each paragraph of the terms and conditions.
You can use HTML formatting and must make sure that the characters you use are safe to display within a web page; for example, you must specify ampersands as & and not as bare & symbols. If you want to include a line break, use <br /> – other formatting codes that may be used in other translation strings may not be displayed correctly or may prevent the terms and conditions from being displayed.
For information about the MyID Translator tool, contact customer support quoting reference SUP-138.
11.6.5 Storing signed terms and conditions
If you set the Persist terms and conditions option (on the Devices tab of the Operation Settings workflow) to Yes, MyID stores the terms and conditions that were signed as a binary object in the database. This is then visible in the MyID audit report.
This option allows you to review the terms and conditions as they stood when the cardholder accepted them, rather than the terms and conditions as they currently stand, which may be different if you have updated the text of the terms and conditions.